home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / g_man / cat3 / OpenGL / glgetstring.z / glgetstring
Encoding:
Text File  |  1998-10-20  |  11.8 KB  |  199 lines
  1.  
  2.  
  3.  
  4. ggggllllGGGGeeeettttSSSSttttrrrriiiinnnngggg((((3333GGGG))))                OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee                ggggllllGGGGeeeettttSSSSttttrrrriiiinnnngggg((((3333GGGG))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ggggllllGGGGeeeettttSSSSttttrrrriiiinnnngggg - returns a string describing the current GL connection
  10.  
  11.  
  12. CCCC SSSSPPPPEEEECCCCIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN
  13.      const GLubyte * ggggllllGGGGeeeettttSSSSttttrrrriiiinnnngggg( GLenum _n_a_m_e )
  14.  
  15.  
  16. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  17.      _n_a_m_e  Specifies a symbolic constant, one of GGGGLLLL____VVVVEEEENNNNDDDDOOOORRRR, GGGGLLLL____RRRREEEENNNNDDDDEEEERRRREEEERRRR,
  18.            GGGGLLLL____VVVVEEEERRRRSSSSIIIIOOOONNNN, or GGGGLLLL____EEEEXXXXTTTTEEEENNNNSSSSIIIIOOOONNNNSSSS.
  19.  
  20. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.      ggggllllGGGGeeeettttSSSSttttrrrriiiinnnngggg returns a pointer to a static string describing some aspect
  22.      of the current GL connection.  _n_a_m_e can be one of the following:
  23.  
  24.      GGGGLLLL____VVVVEEEENNNNDDDDOOOORRRR
  25.              Returns the company responsible for this GL implementation.  This
  26.              name does not change from release to release.  For Silicon
  27.              Graphics the string is "SGI".
  28.  
  29.      GGGGLLLL____RRRREEEENNNNDDDDEEEERRRREEEERRRR
  30.              Returns the name of the renderer.  This name is typically
  31.              specific to a particular configuration of a hardware platform.
  32.              It does not change from release to release.  The renderer strings
  33.              for Silicon Graphics graphic engines are listed in the MACHINE
  34.              DEPENDENCIES section below.
  35.  
  36.      GGGGLLLL____VVVVEEEERRRRSSSSIIIIOOOONNNN
  37.              Returns a version or release number.  For SGI releases prior to
  38.              Irix 5.3 the string is """"1111....0000"""".  For Irix 5.3 and subsequent
  39.              releases the format is
  40.              """"<<<<GGGGLLLL vvvveeeerrrrssssiiiioooonnnn>>>> IIIIrrrriiiixxxx <<<<rrrreeeelllleeeeaaaasssseeee nnnnuuuummmmbbbbeeeerrrr>>>> ppppaaaattttcccchhhh <<<<ppppaaaattttcccchhhh nnnnuuuummmmbbbbeeeerrrr>>>>""""; for
  41.              example in the Irix 5.3 release the string is "1.0 Irix 5.3".
  42.  
  43.      GGGGLLLL____EEEEXXXXTTTTEEEENNNNSSSSIIIIOOOONNNNSSSS
  44.              Returns a space-separated list of supported extensions to GL.
  45.  
  46.      Because the GL does not include queries for the performance
  47.      characteristics of an implementation, some applications are written to
  48.      recognize known platforms and modify their GL usage based on known
  49.      performance characteristics of these platforms.  Strings GGGGLLLL____VVVVEEEENNNNDDDDOOOORRRR and
  50.      GGGGLLLL____RRRREEEENNNNDDDDEEEERRRREEEERRRR together uniquely specify a platform. They do not change from
  51.      release to release and should be used by platform-recognition algorithms.
  52.  
  53.      Some applications want to make use of features that are not part of the
  54.      standard GL.  These features may be implemented as extensions to the
  55.      standard GL.  The GGGGLLLL____EEEEXXXXTTTTEEEENNNNSSSSIIIIOOOONNNNSSSS string is a space seperated list of
  56.      supported GL extensions. (Extension names never contain a space
  57.      character.)
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ggggllllGGGGeeeettttSSSSttttrrrriiiinnnngggg((((3333GGGG))))                OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee                ggggllllGGGGeeeettttSSSSttttrrrriiiinnnngggg((((3333GGGG))))
  71.  
  72.  
  73.  
  74.      The GGGGLLLL____VVVVEEEERRRRSSSSIIIIOOOONNNN string begins with a version number.  The version number
  75.      uses one of these forms:
  76.  
  77.      _m_a_j_o_r__n_u_m_b_e_r._m_i_n_o_r__n_u_m_b_e_r
  78.      _m_a_j_o_r__n_u_m_b_e_r._m_i_n_o_r__n_u_m_b_e_r._r_e_l_e_a_s_e__n_u_m_b_e_r
  79.  
  80.      Vendor-specific information may follow the version number. Its format
  81.      depends on the implementation, but a space always separates the version
  82.      number and the vendor-specific information.
  83.  
  84.      All strings are null-terminated.
  85.  
  86. NNNNOOOOTTTTEEEESSSS
  87.      If an error is generated, ggggllllGGGGeeeettttSSSSttttrrrriiiinnnngggg returns 0.
  88.  
  89.      The pointer returned by ggggllllGGGGeeeettttSSSSttttrrrriiiinnnngggg is only valid while the context
  90.      exists that was current when ggggllllGGGGeeeettttSSSSttttrrrriiiinnnngggg was executed. The safe thing to
  91.      do is to make a copy of the string if that context is to be destroyed.
  92.  
  93.      The client and server may support different versions or extensions.
  94.      ggggllllGGGGeeeettttSSSSttttrrrriiiinnnngggg always returns a compatible version number or list of
  95.      extensions. The release number always describes the server.
  96.  
  97. EEEERRRRRRRROOOORRRRSSSS
  98.      GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____EEEENNNNUUUUMMMM is generated if _n_a_m_e is not an accepted value.
  99.  
  100.      GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____OOOOPPPPEEEERRRRAAAATTTTIIIIOOOONNNN is generated if ggggllllGGGGeeeettttSSSSttttrrrriiiinnnngggg is executed between the
  101.      execution of ggggllllBBBBeeeeggggiiiinnnn and the corresponding execution of ggggllllEEEEnnnndddd.
  102.  
  103.  
  104. MMMMAAAACCCCHHHHIIIINNNNEEEE DDDDEEEEPPPPEEEENNNNDDDDEEEENNNNCCCCIIIIEEEESSSS
  105.      The GGGGLLLL____RRRREEEENNNNDDDDEEEERRRREEEERRRR strings returned by ggggllllGGGGeeeettttSSSSttttrrrriiiinnnngggg for each graphics system
  106.      are listed below.  Square brackets ([,]) surround optional parts of the
  107.      string, and angle brackets (<,>) surround multi-valued parts that are
  108.      always present. Neither the square brackets nor the angle brackets are
  109.      part of the string.
  110.  
  111.      IIIInnnnddddyyyy and XXXXLLLL: """"NNNNEEEEWWWWPPPPOOOORRRRTTTT <<<<nnnnppppllllaaaannnneeeessss>>>>"""", where _n_p_l_a_n_e_s is the number of
  112.           configured bitplanes: 8 or 24.
  113.  
  114.      PPPPeeeerrrrssssoooonnnnaaaallll IIIIrrrriiiissss: """"GGGGRRRR1111....<<<<vvvveeeerrrrssssiiiioooonnnn>>>>[[[[////22224444]]]][[[[////ZZZZ]]]][[[[////TTTTuuuurrrrbbbboooo]]]]"""", where _v_e_r_s_i_o_n is the
  115.           board version: 1 or 2; /_2_4 indicates 24 bitplanes (otherwise 8); /_Z
  116.           indicates a hardware depth buffer; /_T_u_r_b_o indicates the "Turbo"
  117.           option.
  118.  
  119.      VVVVGGGGXXXX and VVVVGGGGXXXXTTTT: """"VVVVGGGGXXXX[[[[TTTT]]]][[[[<<<<ssssppppaaaannnnssss>>>>]]]]"""", where _s_p_a_n_s is either /5 or /10
  120.           indicating the number of spans other than 20.
  121.  
  122.      IIIInnnnddddiiiiggggoooo EEEEnnnnttttrrrryyyy: """"LLLLIIIIGGGGHHHHTTTT"""".
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ggggllllGGGGeeeettttSSSSttttrrrriiiinnnngggg((((3333GGGG))))                OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee                ggggllllGGGGeeeettttSSSSttttrrrriiiinnnngggg((((3333GGGG))))
  137.  
  138.  
  139.  
  140.      OOOO2222: """"CCCCRRRRIIIIMMMMEEEE"""".
  141.  
  142.      XXXXSSSS, XXXXZZZZ, EEEEllllaaaannnn, and EEEExxxxttttrrrreeeemmmmeeee: """"<<<<ttttyyyyppppeeee>>>>----<<<<ggggrrrraaaapppphhhhiiiiccccssss>>>>"""", where _t_y_p_e is one of
  143.           GR2, GR3, GU1 or GR2MP and _g_r_a_p_h_i_c_s is one of XS, XSM, XS24, XS24-Z,
  144.           XZ, Elan, or Extreme, corresponding to the configuration of the
  145.           graphics board.
  146.  
  147.      RRRReeeeaaaalllliiiittttyyyyEEEEnnnnggggiiiinnnneeee, RRRReeeeaaaalllliiiittttyyyyEEEEnnnnggggiiiinnnneeee2222, and VVVVTTTTXXXX: """"<<<<ttttyyyyppppeeee>>>>////<<<<ppppiiiixxxxdddd>>>>////<<<<nnnnrrrrmmmm>>>>////<<<<tttteeeexxxxsssszzzz>>>>"""",
  148.           where _t_y_p_e is REC, RE, REV, RET, or RES, corresponding to Crimson,
  149.           Power Series, Onyx/VTX with R4400, PowerOnyx with R8000, or
  150.           Onyx/PowerOnyx with R10000; _p_i_x_d is S, M, or L, corresponding to
  151.           small, medium, or large pixel depth, respectively; _n_r_m is 1, 2, or
  152.           4, indicating the number of raster manager boards; _t_e_x_s_z is 2 or 8
  153.           indicating the size of the texture memory in megatexels.  (Each
  154.           texel is 16 bits in size.)
  155.  
  156.      SSSSoooolllliiiidddd IIIImmmmppppaaaacccctttt, HHHHiiiigggghhhh IIIImmmmppppaaaacccctttt and MMMMaaaaxxxxiiiimmmmuuuummmm IIIImmmmppppaaaacccctttt: """"IIIIMMMMPPPPAAAACCCCTTTT////<<<<nnnnggggeeee>>>>////<<<<nnnnrrrrssssssss>>>>////<<<<tttteeeexxxxsssszzzz>>>>"""",
  157.           where _n_g_e is 1 or 2, corresponding to the number of GEs; _n_r_s_s is 1
  158.           or 2, corresponding to the number of raster subsystem boards; and
  159.           _t_e_x_s_z is 0, 1 or 4, corresponding to the size of texture memory in
  160.           megabytes.
  161.  
  162.      IIIInnnnffffiiiinnnniiiitttteeeeRRRReeeeaaaalllliiiittttyyyy: """"<<<<ttttyyyyppppeeee>>>>////<<<<ppppiiiixxxxdddd>>>>////<<<<nnnnrrrrmmmm>>>>////<<<<tttteeeexxxxsssszzzz>>>>////<<<<nnnnggggeeee>>>>"""",
  163.           where _t_y_p_e is IR or IRS, corresponding to Onyx with R4400 or R10000,
  164.           respectively; _p_i_x_d is S, M, L, or X, corresponding to small, medium,
  165.           large, or extra large pixel depth, respectively; _n_r_m is 1, 2, or 4,
  166.           indicating the number of raster manager boards; _t_e_x_s_z is 16 or 64
  167.           indicating the size of texture memory in megabytes; and _n_g_e
  168.           indicates the number of Geometry Engines on the geometry engine
  169.           board.
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.